GET api/PatientsByFlags?includeInactives={includeInactives}&flagIds[0]={flagIds[0]}&flagIds[1]={flagIds[1]}&clientId={clientId}&clinicId={clinicId}&pcpId={pcpId}&divisionId={divisionId}

Request Information

URI Parameters

Name	Type	Additional information
includeInactives	boolean	Required
flagIds	Collection of integer	None.
clientId	integer	None.
clinicId	integer	None.
pcpId	string	None.
divisionId	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of PatientsByFlag

Name	Type	Additional information
CPI	string	None.
DIV_ID	integer	None.
LASTNAME	string	None.
FIRSTNAME	string	None.
ACTIVE	boolean	None.
CLIENT_NAME	string	None.
CLINIC_NAME	string	None.
PCP_LASTNAME	string	None.
PCP_FIRSTNAME	string	None.
ID	integer	None.
FLAG	string	None.
IMG	string	None.
CLIENT_ID	integer	None.
CLINIC	integer	None.
PCP	string	None.
UNIQUENAME	string	None.
COACH_LASTNAME	string	None.
COACH_FIRSTNAME	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CPI": "sample string 1",
    "DIV_ID": 2,
    "LASTNAME": "sample string 3",
    "FIRSTNAME": "sample string 4",
    "ACTIVE": true,
    "CLIENT_NAME": "sample string 6",
    "CLINIC_NAME": "sample string 7",
    "PCP_LASTNAME": "sample string 8",
    "PCP_FIRSTNAME": "sample string 9",
    "ID": 10,
    "FLAG": "sample string 11",
    "IMG": "sample string 12",
    "CLIENT_ID": 1,
    "CLINIC": 1,
    "PCP": "sample string 13",
    "UNIQUENAME": "sample string 14",
    "COACH_LASTNAME": "sample string 15",
    "COACH_FIRSTNAME": "sample string 16"
  },
  {
    "CPI": "sample string 1",
    "DIV_ID": 2,
    "LASTNAME": "sample string 3",
    "FIRSTNAME": "sample string 4",
    "ACTIVE": true,
    "CLIENT_NAME": "sample string 6",
    "CLINIC_NAME": "sample string 7",
    "PCP_LASTNAME": "sample string 8",
    "PCP_FIRSTNAME": "sample string 9",
    "ID": 10,
    "FLAG": "sample string 11",
    "IMG": "sample string 12",
    "CLIENT_ID": 1,
    "CLINIC": 1,
    "PCP": "sample string 13",
    "UNIQUENAME": "sample string 14",
    "COACH_LASTNAME": "sample string 15",
    "COACH_FIRSTNAME": "sample string 16"
  }
]

application/octet-stream

Sample:

[{"CPI":"sample string 1","DIV_ID":2,"LASTNAME":"sample string 3","FIRSTNAME":"sample string 4","ACTIVE":true,"CLIENT_NAME":"sample string 6","CLINIC_NAME":"sample string 7","PCP_LASTNAME":"sample string 8","PCP_FIRSTNAME":"sample string 9","ID":10,"FLAG":"sample string 11","IMG":"sample string 12","CLIENT_ID":1,"CLINIC":1,"PCP":"sample string 13","UNIQUENAME":"sample string 14","COACH_LASTNAME":"sample string 15","COACH_FIRSTNAME":"sample string 16"},{"CPI":"sample string 1","DIV_ID":2,"LASTNAME":"sample string 3","FIRSTNAME":"sample string 4","ACTIVE":true,"CLIENT_NAME":"sample string 6","CLINIC_NAME":"sample string 7","PCP_LASTNAME":"sample string 8","PCP_FIRSTNAME":"sample string 9","ID":10,"FLAG":"sample string 11","IMG":"sample string 12","CLIENT_ID":1,"CLINIC":1,"PCP":"sample string 13","UNIQUENAME":"sample string 14","COACH_LASTNAME":"sample string 15","COACH_FIRSTNAME":"sample string 16"}]

application/xml, text/xml

Sample:

<ArrayOfPatientsByFlag xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PatientsByFlag>
    <CPI>sample string 1</CPI>
    <DIV_ID>2</DIV_ID>
    <LASTNAME>sample string 3</LASTNAME>
    <FIRSTNAME>sample string 4</FIRSTNAME>
    <ACTIVE>true</ACTIVE>
    <CLIENT_NAME>sample string 6</CLIENT_NAME>
    <CLINIC_NAME>sample string 7</CLINIC_NAME>
    <PCP_LASTNAME>sample string 8</PCP_LASTNAME>
    <PCP_FIRSTNAME>sample string 9</PCP_FIRSTNAME>
    <ID>10</ID>
    <FLAG>sample string 11</FLAG>
    <IMG>sample string 12</IMG>
    <CLIENT_ID>1</CLIENT_ID>
    <CLINIC>1</CLINIC>
    <PCP>sample string 13</PCP>
    <UNIQUENAME>sample string 14</UNIQUENAME>
    <COACH_LASTNAME>sample string 15</COACH_LASTNAME>
    <COACH_FIRSTNAME>sample string 16</COACH_FIRSTNAME>
  </PatientsByFlag>
  <PatientsByFlag>
    <CPI>sample string 1</CPI>
    <DIV_ID>2</DIV_ID>
    <LASTNAME>sample string 3</LASTNAME>
    <FIRSTNAME>sample string 4</FIRSTNAME>
    <ACTIVE>true</ACTIVE>
    <CLIENT_NAME>sample string 6</CLIENT_NAME>
    <CLINIC_NAME>sample string 7</CLINIC_NAME>
    <PCP_LASTNAME>sample string 8</PCP_LASTNAME>
    <PCP_FIRSTNAME>sample string 9</PCP_FIRSTNAME>
    <ID>10</ID>
    <FLAG>sample string 11</FLAG>
    <IMG>sample string 12</IMG>
    <CLIENT_ID>1</CLIENT_ID>
    <CLINIC>1</CLINIC>
    <PCP>sample string 13</PCP>
    <UNIQUENAME>sample string 14</UNIQUENAME>
    <COACH_LASTNAME>sample string 15</COACH_LASTNAME>
    <COACH_FIRSTNAME>sample string 16</COACH_FIRSTNAME>
  </PatientsByFlag>
</ArrayOfPatientsByFlag>